home *** CD-ROM | disk | FTP | other *** search
/ The Arsenal Files 8 / The Arsenal Files Collection #8 (Arsenal Computer) (1996).ISO / g_quake / quma10.zip / README.TXT < prev    next >
Text File  |  1996-08-30  |  9KB  |  163 lines
  1. FILELIST:
  2. The zip file should contain the following files
  3. bsp.bat        example batch file that builds a BSP from a MAP file
  4. entities.txt    list of valid entities and their properties (available for expansion)
  5. quma.exe     application
  6. readme.doc    this file (in MS Word format)
  7. readme.txt    this file in plain text format
  8. test.bat        example batch file that runs Quake with the BSP file
  9. updates.doc    version fixes/feature info
  10.  
  11.  
  12. QuMa:
  13.  
  14.     QuMa is a utility for creating maps for use with the game Quake.  It is my humble contribution to 
  15. the world of head to head deathmatch gaming. 
  16.  
  17. OFFICIAL HOME PAGE:  Check here for info and updates http://www.teleport.com/~benw/quma
  18.  
  19. LEGAL STUFF:
  20.  
  21. This program and its documentation are copyright c1996 Negative Eddy Software and Ben 
  22. Williams.  All rights reserved.  QuMa is offered with no warranty or guarantee so use it at your own risk.  
  23. By downloading and using this software you, the user, agree to take full responsibility for anything that 
  24. happens.  The maker of this software is in no way responsible for anything that may happen. You may 
  25. redistribute QuMa freely as long as all the files listed above are included and have not been modified and 
  26. no charge or fee is collected (normal BBS/online service fees excluded) for the service.  Anyone wishing to 
  27. include this program in any type of anthology or cd-rom must get permission from the author of QuMa first.
  28. Since QuMa is a spare time project for me it may still have some small bugs but I think that I 
  29. sorted most of them out.  I welcome useful suggestions and any feedback in the form of email 
  30. (benw@teleport.com).  If you try it and like it please drop me a line saying something like "Hey, I think 
  31. QuMa is cool!" Thanks for trying it out and now on with the show.(nobody reads these instructions anyway)
  32.  
  33. Requirements:
  34. Windows95 with DirectX2 installed
  35.  
  36. CameraView (upper left)- Works like 3d first person games
  37.  
  38. NOTE: by default the camera is off - it must be turned on by selecting a type of display in the menu 
  39. View->Camera->DisplayOption
  40.  
  41. Flat drawing mode draws objects in different colors depending on the orientation of the surface in order to 
  42. help show edges when no lighting is involved
  43.  
  44. arrow keys: move forward/back, turn left/right
  45. z: move left
  46. x: move right
  47. pgup: move up
  48. pgdown: move down
  49.  
  50.  
  51. XYView (bottom left): 
  52. Current entity is drawn in BLUE, others in BLACK; selected brushes in current entity draw in RED.  Entity 
  53. names are drawn immediately below the entities bounding box (can be turned off in the menu - on by 
  54. default)
  55.  
  56. click-drag:
  57.     If the entity is modifiable - i.e. its not a thing like a light, weapon, or person and  no brush is 
  58. selected it creates a new brush in the current entity which is a cube of height MinZ to MaxZ (as shown in 
  59. the Zview).  If a brush is selected it will drag the brush if it was clicked inside the brush or drag the nearest 
  60. edge to resize the brush if clicked outside the brush.
  61.     
  62. Double-click:
  63.     Sets the Z-View point (marked by a small pruple circle)
  64.  
  65. Shift-click: selects/deselects the brush, if selected brush not in the current entity the current entity is 
  66. changed to be that of the new brush
  67.  
  68. Ctrl-click: points the camera view in the direction of the place clicked
  69.  
  70. Ctrl-Double-click places the camera at the click spot
  71.  
  72. Keys:
  73. -: subtracts the brush selection form the rest of the current entity (handy for making doors and tunneling out 
  74. other brushes)
  75. delete: removes the selected brush 
  76. esc: unselects all brushes
  77. tab: changes current entity to next one in list
  78. return: (if in clipper mode) carves selected brushes with the clipper plane in the direction of the normal of 
  79. the clipper plane.  The normal direction can be determined using the right hand rule.
  80. /:  (if in clipper mode) flips the normal on the clipper plane
  81.  
  82. ZView:
  83. Current entity is drawn in BLUE, others in BLACK; selected brushes in current entity draw in RED
  84.  
  85. click-drag:
  86.     If a brush is selected it will drag the nearest edge to resize the brush if clicked above the brush 
  87. otherwise it will drag the brush up or down
  88.  
  89. Shift-click: selects deselects the brush
  90.  
  91. Ctrl-click: places the camera at the height of the clicked spot
  92.  
  93. Context menu: allow you to change the current MinZ and MaxZ (shown by two red lines) for brush creation
  94.  
  95. Clipper:
  96. the clipper is a special mode which allows you to shape the brushes beyond just cubes.  Enter clipper mode 
  97. by selecting it from the menu or from the context menu in XYView.
  98. Then by single clicking in the XYView the clipper places 3 points which define the clipping plane. If an 
  99. exact point is clicked on again it will be move from MinZ to MaxZ resulting in a sloped plane.  The side of 
  100. the plane which is clipped out of existence depends on the clockwise/counterclockwiseness of the points.  
  101. Use the right hand rule to determine which side is clipped away. When the enter key is pressed the selected 
  102. brushes will be carved so that all parts of the selected brushes on the clipper side of the plane are deleted,  
  103. leaving only the portion of the selected brushes on the other side of the clipper plane.
  104.  
  105. Key Points:
  106. To change the current entity you can TAB in the XYView or select a brush in that entity.  To 
  107. change an entities attributes just make it the current entity and go Entity->Properties or double click its 
  108. properties in the dialog view.
  109. To make an new entity drag a brush into the main map then select 'Make into entity' from the edit 
  110. menu.  This brings up the entity dialog box which will make an new entity out of the selected brushes (fixed 
  111. size entities will have their brushes resized to the proper size for that entity and will not be able to change 
  112. size).  Add Light entities so that you can see things in the camera view in Flat shaded mode (light value >= 
  113. 500 is good and bright)
  114.  
  115. Set the default texture (Edit menu) before creating a brush. - at this point all parts of a brush have the same 
  116. texture. Using this feature requires a Wad file with the quake textures in it (I got them from  
  117. http://www.wf.net/~stephenc/ along with the map->bsp utilities or you can find a copy of pak2wad to 
  118. extract them yourself). QuMa saves the name of your current wad file so you only have to set it the first 
  119. time you run it.
  120.  
  121. Stairs:  to create stairs just select a single brush whose height goes from the bottom of the first step to the 
  122. top of the last.  Select Brush->Make into Stairs from the menu (or use the toolbar or context menu) and tell 
  123. QuMa how high to make each step and which end of the stairs is the elevated end.  Viola! Instant stairs 
  124. automatically calculated.
  125.  
  126. To connect to entities (i.e. make one a target of another like a button and a door) select the entity that you 
  127. want to be the trigger then right click on the entity you want to be the target and select Connect Entities. 
  128. This automatically generates a target name and target for the two entities.  Also if one of the entities already 
  129. has that attribute it will be used for the other  instead of overwriting it.  Of course you can also set up the 
  130. targets manually with the entity properties dialog.
  131.  
  132. Scaling factor is set to a default of 2 (twice or half the size).  This can be adjusted under the brush menu
  133.  
  134. Key Concepts:
  135. Brushes are just walls
  136. Entities are things - the map, weapons, triggers, teleport destinations
  137. Check out http://www.infi.net/~nichd/qmapspec.html for examples of how to create doors and stuff using 
  138. triggers and targetnames
  139.  
  140. Please let me know of a list of features/ changes you would like to see (and importance of them). And for 
  141. any bug reports please be specific and explain how to duplicate the issue (which window was active what 
  142. you did last etc.) Send all correspondence to benw@teleport.com.
  143.  
  144. Helpful Places and Documents:
  145. The list of helpful places for quake editing is avaliable at the QuMa web site:
  146. http://www.teleport.com/~benw/quma
  147.  
  148. Special thanks to:
  149.  Id Software for creating something so cool and making it as unbelievably customizable as it is
  150. The guys who wrote The Unofficial Quake Specs and the Quake Map Specs which made this possible
  151. My beta testers for asking for the impossible and just generally helping out
  152. My wife for putting up with all this nonsense about Quake
  153.  
  154.  
  155. Troubleshooting:
  156.  
  157. n If QuMa doesn't run when clicked on make sure the entities.txt file is in the same directory as the exe 
  158. file.
  159. n If the texture select dialog box displays the names of the textures and a black box instead of the proper 
  160. colors then your WAD file doesn't contain a palette.  Replace it with one that does.
  161. n If the your display is not in 256 color mode then the texture select dialog box will not display the 
  162. textures correctly
  163.